<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Value</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface Value</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A generic holder for the value of a <a href="../phpContentRepository/Property.html">Property</a>.</p>
<p class="description"><p>Can be used without knowing the exact type (string, double, stream etc.)</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
				<li><span class="field">see:</span> <a href="../phpContentRepository/BaseValue.html">BaseValue</a>, <a href="../phpContentRepository/BinaryValue.html">BinaryValue</a>, <a href="../phpContentRepository/BooleanValue.html">BooleanValue</a>, <a href="../phpContentRepository/DateValue.html">DateValue</a>, <a href="../phpContentRepository/DoubleValue.html">DoubleValue</a>, <a href="../phpContentRepository/LongValue.html">LongValue</a>, <a href="../phpContentRepository/ReferenceValue.html">ReferenceValue</a>, <a href="../phpContentRepository/SoftLinkValue.html">SoftLinkValue</a>, <a href="../phpContentRepository/StringValue.html">StringValue</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Value_interface_php.html">/Value.interface.php</a> (line <span class="field">39</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#getBoolean" title="details" class="method-name">getBoolean</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getDate" title="details" class="method-name">getDate</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">float</span>
										<a href="#getDouble" title="details" class="method-name">getDouble</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int/long</span>
										<a href="#getLong" title="details" class="method-name">getLong</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">object
 A</span>
										<a href="#getStream" title="details" class="method-name">getStream</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getString" title="details" class="method-name">getString</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getType" title="details" class="method-name">getType</a>
										()
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetBoolean" id="getBoolean"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getBoolean</span> (line <span class="line-number">202</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the boolean representation of this value.</p>
<p class="description"><p>Unlike <a href="../phpContentRepository/Property.html#methodgetBoolean">Property::getBoolean()</a> this method throws a  <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a> if conversion is not possible.</p><p>Same as level 1.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A boolean representation of this value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a>    If, due to its type or format, this value cannot be converted to    boolean or the value is null (i.e., empty).</li>
				<li><span class="field">throws:</span> IllegalStateException    If <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> has been called previously at least once.</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If another error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			getBoolean
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetDate" id="getDate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getDate</span> (line <span class="line-number">156</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the Calendar representation of this value.</p>
<p class="description"><p>Unlike <a href="../phpContentRepository/Property.html#methodgetDate">Property::getDate()</a> this method throws a  <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a> if conversion is not possible.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Calendar representation of this value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a>    If, due to its type or format, this value cannot be converted to    Calendar or the value is NULL (i.e., empty).</li>
				<li><span class="field">throws:</span> IllegalStateException    If <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> has been called previously at least once.</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If another error occurs.</li>
				<li><span class="field">todo:</span> This may need to be adjusted, as PHP does not have a default    Calendar object.  Alternatives might include returning the results of a    date(), a timestamp, or possibly creating a basic Calendar object.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getDate
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetDouble" id="getDouble"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getDouble</span> (line <span class="line-number">105</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the float/double representation of this value.</p>
<p class="description"><p>Unlike<a href="../phpContentRepository/Property.html#methodgetDouble">Property::getDouble()</a> this method throws a  <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a> if conversion is not possible.</p><p>PHP Specific: PHP does not implement a double, but instead uses  a <a href="http://us2.php.net/manual/en/language.types.float.php">float</a>.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A float representation of this value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a>    If, due to its type or format, this value cannot be converted to    float or the value is NULL (i.e., empty).</li>
				<li><span class="field">throws:</span> IllegalStateException    If <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> has been called previously at least once.</li>
				<li><span class="field">throws:</span> RepositoryException If another error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">float</span>
		<span class="method-name">
			getDouble
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetLong" id="getLong"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getLong</span> (line <span class="line-number">180</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the int/long representation of this value.</p>
<p class="description"><p>Unlike <a href="../phpContentRepository/Property.html#methodgetLong">Property::getLong()</a> this method throws a  <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a> if conversion is not possible.</p><p>PHP Specific: PHP does not implement a long, so this  method should return an  <a href="http://us2.php.net/manual/en/language.types.integer.php">integer</a></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> An integer representation of this value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a>    If, due to its type or format, this value cannot be converted to    integer or the value is null (i.e., empty).</li>
				<li><span class="field">throws:</span> IllegalStateException    If <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> has been called previously at least once.</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If another error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int/long</span>
		<span class="method-name">
			getLong
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetStream" id="getStream"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getStream</span> (line <span class="line-number">132</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the InputStream representation of this value.</p>
<p class="description"><p>Unlike <a href="../phpContentRepository/Property.html#methodgetStream">Property::getStream()</a> this method throws a  <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a> if conversion is not possible.</p><p>Please note that calling <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> repeatedly will always  return the same InputStream object.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> InputStream representation of this value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a>    If, due to its type or format, this value cannot be converted to    InputStream (since everything can be converted to string, this    should never happen) or the value is NULL (i.e., empty).</li>
				<li><span class="field">throws:</span> IllegalStateException    If any getter methods other than <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> and    <a href="../phpContentRepository/Value.html#methodgetType">getType()</a> have been called previously at least once.</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If another error occurs.</li>
				<li><span class="field">todo:</span> Determine if it is possible to implement this in PHP.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 A</span>
		<span class="method-name">
			getStream
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetString" id="getString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getString</span> (line <span class="line-number">82</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the string representation of this value.</p>
<p class="description"><p>Unlike <a href="../phpContentRepository/Property.html#methodgetString">Property::getString()</a>, this method throws a  <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a> if conversion is not possible.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A string representation of this value</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/ValueFormatException.html">ValueFormatException</a>    If, due to its type or format, this value cannot be converted to string    (since everything can be converted to string, this should never happen)    or the value is NULL (i.e., empty).</li>
				<li><span class="field">throws:</span> IllegalStateException    If <a href="../phpContentRepository/Value.html#methodgetStream">getStream()</a> has been called previously at least once.</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/RepositoryException.html">RepositoryException</a>    If another error occurs.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getString
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetType" id="getType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getType</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the type of this Value.</p>
<p class="description"><p>One of:  <ul><li><a href="../phpContentRepository/PropertyType.html#constSTRING">PropertyType::STRING</a></li><li><a href="../phpContentRepository/PropertyType.html#constDATE">PropertyType::DATE</a></li><li><a href="../phpContentRepository/PropertyType.html#constBINARY">PropertyType::BINARY</a></li><li><a href="../phpContentRepository/PropertyType.html#constDOUBLE">PropertyType::DOUBLE</a></li><li><a href="../phpContentRepository/PropertyType.html#constLONG">PropertyType::LONG</a></li><li><a href="../phpContentRepository/PropertyType.html#constBOOLEAN">PropertyType::BOOLEAN</a></li><li><a href="../phpContentRepository/PropertyType.html#constSOFTLINK">PropertyType::SOFTLINK</a></li><li><a href="../phpContentRepository/PropertyType.html#constREFERENCE">PropertyType::REFERENCE</a></li></ul></p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">see:</span> PropertyType

 The type returned is that which was set at property creation.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getType
		</span>
				()
			</div>
	
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:25 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>